覆盖主要内容
版本: 下个版本

创建自己的 API 接口

本文档为您介绍如何快速的搭建一个 API 接口。

使用 node.js 的 express 构建接口

express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架,我们将介绍如何使用它快速的为您的应用创建一个 API 接口。

  1. 打开 Node.js 下载链接 ,下载并安装适合您电脑平台的 node.js 环境,如果您的电脑已经安装 node.js 可以跳过此步骤。
信息

说明 安装好后,打开电脑的终端,输入命令 node -v 和 npm -v ,如果有输出一串版本号信息,则说明已经安装成功。

  1. 使用以下指令安装 express-generator 。
npm i express-generator -g
  1. 进入/新建一个工作目录,在该位置打开终端,并输入以下命令(其中 air_quality 为你新建的 express 项目的名称)
express air_quality

  1. 进入 air_quality 目录,并安装依赖包。
cd air_quality # 切换到 air_quality 目录
npm install # 安装依赖
  1. 启动 express 项目,并在浏览器访问 http://localhost:3000 查看效果。
DEBUG=air-quality:* npm start # 部分电脑命令可能不同,以运行第三步指令后输出的 run the app 后的指令为准。

# 你也可以直接输入 npm start 来运行项目(非调试模式)

  1. 配置你的接口。你可以修改 ./routes/ 目录下的文件,来实现你自己的接口。可以参照 处理接口 第4步。
  2. 修改默认端口。如果你需要你的 api 运行在其他端口,请在 ./app.js 中添加如下内容。
process.env.PORT = '8888'

  1. 为避免跨域请求的问题,我们强烈建议您安装并使用 cors 模块。
    1. 在项目目录下的终端输入 npm i cors 命令,安装 cors 模块。
    2. ./app.js 文件中加入 app.use(cors()) 。保存并重新运行即可生效。